fix #1041 #1049
Merged
fix #1041 #1049
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
hamelsmu
reviewed
Sep 13, 2022
| @@ -79,7 +79,7 @@ def _clean_cell(cell, clear_all, allowed_metadata_keys, clean_ids): | |||
| # %% ../nbs/api/clean.ipynb 13 | |||
| def clean_nb( | |||
| nb, # The notebook to clean | |||
| clear_all=False, # Remove all cell metadata and cell outputs | |||
| clear_all=False, # Remove all cell metadata and cell outputs? | |||
There was a problem hiding this comment.
Do you think the question mark could be confusing? It is a bit confusing for me
Meaning I interpret it as we aren't sure what the program will do
There was a problem hiding this comment.
It's something I noticed Jeremy doing to describe bool parameters and quite liked myself. I think you get used to reading the ? as not sounding confused 😄
hamelsmu
approved these changes
Sep 14, 2022
|
Do you think the question mark could be confusing? It is a bit confusing for me
Meaning I interpret it as we aren't sure what the program will do
Personally I pretty much always like to use a "?" on boolean params. It's a fairly standard approach - e.g some languages actually require "?" in their syntax!
Perhaps the docment could be rephrased to make the question clearer?
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Config.typesfromdocments(_apply_defaults)